Add string literal completions for `package.json` `imports` field by Andarist · Pull Request #57718 · microsoft/TypeScript

Mateusz Burzyński (Andarist) · 2024-03-11T10:25:06Z

closes #52460
closes #57680
closes #57777

Currently, this only has tests based on #55015 but I still have to add more

Mateusz Burzyński (Andarist) · 2024-03-11T10:26:35Z

 }

+/** @internal */
+export function getPossibleOriginalInputPathWithoutChangingExt(


this is kinda a reverse of getOutputPathWithoutChangingExt:

TypeScript/src/compiler/emitter.ts

Lines 542 to 554 in 3fca8c8

function getOutputPathWithoutChangingExt(

inputFileName: string,

ignoreCase: boolean,

outputDir: string | undefined,

getCommonSourceDirectory: () => string,

): string {

return outputDir ?

resolvePath(

outputDir,

getRelativePathFromDirectory(getCommonSourceDirectory(), inputFileName, ignoreCase),

) :

inputFileName;

}

Mateusz Burzyński (Andarist) · 2024-03-11T10:46:29Z

Andrew Branch (@andrewbranch) I opened this as a draft because there are some minor cleanups to be done here. I'd appreciate an early review here though - in case there is something fundamentally wrong with this.

Daniel Rosenwasser (DanielRosenwasser) · 2024-08-23T00:21:06Z

Mateusz Burzyński (@Andarist) did you still want to pursue this? We're looking to get this done in the TS 5.7 timeframe.

Mateusz Burzyński (Andarist) · 2024-08-23T05:24:37Z

Daniel Rosenwasser (@DanielRosenwasser) yes, it would be great if Andrew Branch (@andrewbranch) could give this a quick look to check if im not doing anything overly wrong so I dont spend too much time on cleaning up things that will turn out to be wrong in the end ;p

Andrew Branch (andrewbranch)

Yeah, this looks on the right track to me, thanks!

Mateusz Burzyński (Andarist) · 2024-09-25T05:11:23Z

Andrew Branch (@andrewbranch) thanks for the review! I’ll try to clean this up asap

…letions # Conflicts: # src/compiler/utilities.ts # src/services/stringCompletions.ts

Mateusz Burzyński (Andarist) · 2024-10-17T08:40:03Z

            const value = normalizeFileSetEntry(files[key]);
            const path = dirname ? vpath.resolve(dirname, key) : key;
-            vpath.validate(path, vpath.ValidationFlags.Absolute);
+            vpath.validate(path, vpath.ValidationFlags.Absolute | vpath.ValidationFlags.AllowWildcard);


I have no idea if this is completely correct. I added it to make pathCompletionsPackageJsonImportsSrcNoDistWildcard6 pass as it's using ? in the component path component.

I have added that test based on the existing pathCompletionsPackageJsonExportsWildcard6. The difference is that the test I have added is a fourslash/server test and it follows a slightly different codepath.

The existing one validates here:

TypeScript/src/harness/vfsUtil.ts

Lines 1104 to 1108 in b8e4ed8

private _resolve(path: string) {

return this._cwd

? vpath.resolve(this._cwd, vpath.validate(path, vpath.ValidationFlags.RelativeOrAbsolute | vpath.ValidationFlags.AllowWildcard))

: vpath.validate(path, vpath.ValidationFlags.Absolute | vpath.ValidationFlags.AllowWildcard);

}

And the ValidationFlags.AllowWildcard was added there here

On the other hand, the fourslash/server validates here, where I'm adding this comment. This codepath was added as part of #20763 - which proceeds the PR that introduced ValidationFlags.AllowWildcard. So perhaps this was just a harmless omission in that newer PR. I don't know why this is a flag in the first place though so 🤷‍♂️

Ron Buckton (@rbuckton) can you advise?

…r granular reuse

…ndSuffix`

Mateusz Burzyński (Andarist) · 2024-10-17T10:51:51Z

Andrew Branch (@andrewbranch) it's ready for re-review :)

I could also use a build of this to test it more easily in a real project, and not only in the test harness ;p cc Jake Bailey (@jakebailey)

Jake Bailey (jakebailey) · 2024-10-31T19:17:59Z

TypeScript Bot (@typescript-bot) pack this

TypeScript Bot (typescript-bot) · 2024-10-31T19:18:03Z

Starting jobs; this comment will be updated as builds start and complete.

Command	Status	Results
`pack this`	✅ Started	✅ Results

TypeScript Bot (typescript-bot) · 2024-10-31T19:20:01Z

Hey Jake Bailey (@jakebailey), I've packed this into an installable tgz. You can install it for testing by referencing it in your package.json like so:

{
    "devDependencies": {
        "typescript": "https://typescript.visualstudio.com/cf7ac146-d525-443c-b23c-0d58337efebc/_apis/build/builds/164040/artifacts?artifactName=tgz&fileId=7D1CD9129128DE0FC3646A76F014BB023412AEA343119330949BF42DF191661C02&fileName=/typescript-5.7.0-insiders.20241031.tgz"
    }
}

and then running npm install.

There is also a playground for this build and an npm module you can use via "typescript": "npm:@typescript-deploys/pr-build@5.7.0-pr-57718-9".;

Jake Bailey (jakebailey)

I think this is okay; the FS thing I think is also fine? Everything passes...

Add string literal completions for package.json imports field

238651d

TypeScript Bot (typescript-bot) added the For Backlog Bug PRs that fix a backlog bug label Mar 11, 2024